/*
 * Copyright © 2015 The Gravitee team (http://gravitee.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gravitee.repository.distributedsync.api;

import io.gravitee.repository.distributedsync.model.DistributedSyncState;
import io.reactivex.rxjava3.core.Completable;
import io.reactivex.rxjava3.core.Maybe;

/**
 * @author Guillaume LAMIRAND (guillaume.lamirand at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface DistributedSyncStateRepository {
    Completable ready();

    /**
     * Find for {@link DistributedSyncState} from its cluster id.
     *
     * @param clusterId cluster id to look for
     *
     * @return {@link DistributedSyncState} found or not.
     */
    Maybe<DistributedSyncState> findByClusterId(final String clusterId);

    /**
     * This method allows to create or update {@link DistributedSyncState}
     *
     * @param distributedSyncState {@link DistributedSyncState} to store
     * @return the {@link DistributedSyncState} created or updated
     */
    Completable createOrUpdate(final DistributedSyncState distributedSyncState);
}
